------ S S  E X T R A C T  v0.2 ------

This is a handy-dandy little statistic extractor for VIE style SubSpace 
billing database files.  This extractor was designed with the capability 
for automated/scheduled extractions in mind, for which the companion GUI 
version proves insufficient.  I will continue to add features and correct 
bugs as/if needed.


Features
--------
* Can have multiple INI file configurations for each zone/scoreID
* Can save logged output to a chosen location
* Can suppress some/all logged messages (good for auto-extraction)
* Can process each scoreID individually, or process ALL scores at once
* DAT files need not be in same directory as ssextract
* Can write results to a desired directory other than working directory
* Can put results for each scoreID in a distinct subdirectory
* Can associate scoreID's with zone names to facilitate readability
* Can include references to a style sheet in the HTML output
* Computes up to 8 different statistics for both users and squads, each
* Can compute total billing-wide usage statistics


Installation
------------
Setup is straightforward.  Unzip into an empty directory and run the 
executable.  The necessary files will be generated automatically.  Edit 
the flags in the INI file to customize the extraction behavior.  If 
using subdirectories, add any desired ScoreID:Zone pairs to zoneinfo.txt.


Usage
-----
ssextract [-quiet] [-veryquiet] [-L<logfile>] [-F<inifile>] [-Z<nfofile>]

	-quiet		Nothing logged to console; still logged to logfile
	-veryquiet	Nothing logged to console; nothing logged to logfile
	-L<logfile>	Specify a particular file for the output log
	-F<inifile>	Specify a particular INI file
	-Z<nfofile>	Specify a particular ScoreID:Zone info file

Note: there is no space between the L/F/Z flags and their corresponding 
file name.  For example, to specify the file "myini.ini" on the command 
line, you would type:

	ssextract -Fmyini.ini


INI Parameter Explanations
--------------------------
[General]
DatUser:		Specify the path to each DAT file
DatSquad:		Specify the path to each DAT file
DatScore:		Specify the path to each DAT file
ScoreID:		Compute stats for this ID; compute for ALL scoreID's if 0
Min Kills:		Min kills needed before being included in certain stats
TopX:			How many stats to show (e.g. Top 10)

[User]
DoTotalPoints:	Compute TopX user total points
DoFlagPoints:	Compute TopX user flag points
DoKillPoints:	Compute TopX user kill points
DoAvgKill:		Compute TopX user average kill points
DoWins:			Compute TopX user wins (kills)
DoLosses:		Compute TopX user losses (deaths)
DoRatio:		Compute TopX user W:L ratio
DoRating:		Compute TopX user VIE rating

[Squad]
MinMembers:		Min # of members for squad to be included in certain stats
DoTotalPoints:	Compute TopX squad total points
DoAvgPoints:	Compute TopX squad average points (per player)
DoAvgKill:		Compute TopX squad average kill points (per player)
DoWins:			Compute TopX squad total wins (kills)
DoLosses:		Compute TopX squad total losses (deaths)
DoRatio:		Compute TopX squad W:L ratio
DoRating:		Compute TopX squad VIE rating
DoMembers:		Compute TopX squad membership count

[Usage]
LastDays:			Number of days over which to count active/new users
DoActivePlayers:	Compute number of active users in LastDays
DoNewPlayers:		Compute number of new users in LastDays
DoAllPoints:		Compute total points scored
DoAvgKill:			Compute overall average kill
DoAllFlagPoints:	Compute total flag points scored
DoAllKillPoints:	Compute total kill points scored
DoAllKills:			Compute total number of kills
DoAllPlayers:		Report total number of users in database
DoAllSquads:		Report total number of squads in database

[Output]
Text:			Output results in separate text files
HTML:			Output results in separate HTML files
HTMLGroup:		Output results in a grouped HTML file
Footer:			Suppress/allow footer information in HTML files
StyleSheet:		Include reference to this stylesheet in HTML files
Directory:		Specify an output directory (must already exist!)
UseSubDir:		Specify whether to write results to separate subdirs


Notes
-----
* The path to each DAT file may be a full path, eliminating the need for 
the extraction tool to be located in the same directory as the DAT files.
* If ScoreID=0, stats will be computed for all ScoreID's present in the 
database, otherwise stats will only be computed for the ScoreID given.
* The output directory must already exist, ssextract will NOT create it!
* When using subdirs, any nonexistent subdirs will be created.
* The subdir names will be determined from the score ID and any info 
provided in the zoneinfo.txt file


Contact Info
------------
Send problems/errors/bugs or suggestions to me at:
Email:	LordMaucaub@hotmail.com
ICQ:	603990


Acknowledgements
----------------
Thanks to JJ! for the suggestion to incorporate style sheets, as well as
his continued feedback and support with respect to the HTML output.

